Class EasyVpnClientImpl

All Implemented Interfaces:
IPCObject, EasyVpnClient, Process

public class EasyVpnClientImpl extends ProcessImpl implements EasyVpnClient
Information provided by the PKI file:

    \class EasyVpnClient
    
    \brief EasyVpnClient is the process that handles the Easy VPN client.
    
    \example network().getDevice("PC0").getProcess("EasyVpnClient")
    
Author:
Auto-generated
  • Constructor Details

  • Method Details

    • setServerIp

      public void setServerIp(IPAddress serverIp)
      Information provided by the PKI file:
      
          \brief Sets the server IP address for the Easy VPN client.
          
          \param serverIp, the server IP address for the Easy VPN client.
          
              
      Specified by:
      setServerIp in interface EasyVpnClient
      Parameters:
      serverIp - Takes in a parameter of serverIp
    • getServerIp

      public IPAddress getServerIp()
      Information provided by the PKI file:
      
          \brief Returns the server IP address for the Easy VPN client.
          
          \return ip, the server IP address for the Easy VPN client.
          
              
      Specified by:
      getServerIp in interface EasyVpnClient
      Returns:
      IPAddress Returns a IPAddress
    • setUsername

      public void setUsername(String username)
      Information provided by the PKI file:
      
          \brief Sets the username for the Easy VPN client.
          
          \param username, the username for the Easy VPN client.
          
              
      Specified by:
      setUsername in interface EasyVpnClient
      Parameters:
      username - Takes in a parameter of username
    • getUsername

      public String getUsername()
      Information provided by the PKI file:
      
          \brief Returns the username for the Easy VPN client.
          
          \return string, the sername for the Easy VPN client.
          
              
      Specified by:
      getUsername in interface EasyVpnClient
      Returns:
      String Returns a String
    • setPassword

      public void setPassword(String password)
      Information provided by the PKI file:
      
          \brief Sets the password for the Easy VPN client.
          
          \param password, the password for the Easy VPN client.
          
              
      Specified by:
      setPassword in interface EasyVpnClient
      Parameters:
      password - Takes in a parameter of password
    • getPassword

      public String getPassword()
      Information provided by the PKI file:
      
          \brief Returns the password for the Easy VPN client.
          
          \return string, the password for the Easy VPN client.
          
              
      Specified by:
      getPassword in interface EasyVpnClient
      Returns:
      String Returns a String
    • setGroupName

      public void setGroupName(String groupName)
      Information provided by the PKI file:
      
          \brief Sets the group name for the Easy VPN client.
          
          \param groupName, the group name for the Easy VPN client.
          
              
      Specified by:
      setGroupName in interface EasyVpnClient
      Parameters:
      groupName - Takes in a parameter of groupName
    • getGroupName

      public String getGroupName()
      Information provided by the PKI file:
      
          \brief Returns the group name for the Easy VPN client.
          
          \return string, the group name for the Easy VPN client.
          
              
      Specified by:
      getGroupName in interface EasyVpnClient
      Returns:
      String Returns a String
    • setGroupKey

      public void setGroupKey(String groupKey)
      Information provided by the PKI file:
      
          \brief Sets the group key for the Easy VPN client.
          
          \param groupKey, the group key for the Easy VPN client.
          
              
      Specified by:
      setGroupKey in interface EasyVpnClient
      Parameters:
      groupKey - Takes in a parameter of groupKey
    • getGroupKey

      public String getGroupKey()
      Information provided by the PKI file:
      
          \brief Returns the group key for the Easy VPN client.
          
          \return string, the group key for the Easy VPN client.
          
              
      Specified by:
      getGroupKey in interface EasyVpnClient
      Returns:
      String Returns a String
    • setTunnelIp

      public void setTunnelIp(IPAddress tunnelIp)
      Information provided by the PKI file:
      
          \brief Sets the tunnel IP address for the Easy VPN client.
          
          \param tunnelIp, the tunnel IP address for the Easy VPN client.
          
              
      Specified by:
      setTunnelIp in interface EasyVpnClient
      Parameters:
      tunnelIp - Takes in a parameter of tunnelIp
    • getTunnelIp

      public IPAddress getTunnelIp()
      Information provided by the PKI file:
      
          \brief Returns the tunnel IP address for the Easy VPN client.
          
          \return ip, the tunnel IP address for the Easy VPN client.
          
              
      Specified by:
      getTunnelIp in interface EasyVpnClient
      Returns:
      IPAddress Returns a IPAddress
    • setTunnelMask

      public void setTunnelMask(IPAddress tunnelMask)
      Information provided by the PKI file:
      
          \brief Sets the tunnel mask for the Easy VPN client.
          
          \param tunnelIp, the tunnel mask for the Easy VPN client.
          
              
      Specified by:
      setTunnelMask in interface EasyVpnClient
      Parameters:
      tunnelMask - Takes in a parameter of tunnelMask
    • getTunnelMask

      public IPAddress getTunnelMask()
      Information provided by the PKI file:
      
          \brief Returns the tunnel mask for the Easy VPN client.
          
          \return ip, the tunnel mask for the Easy VPN client.
          
              
      Specified by:
      getTunnelMask in interface EasyVpnClient
      Returns:
      IPAddress Returns a IPAddress
    • connect

      public void connect()
      Information provided by the PKI file:
      
          \brief Connects the Easy VPN client.
          
              
      Specified by:
      connect in interface EasyVpnClient
    • disconnect

      public void disconnect()
      Information provided by the PKI file:
      
          \brief Disconnects the Easy VPN client.
          
              
      Specified by:
      disconnect in interface EasyVpnClient
    • isConnected

      public boolean isConnected()
      Information provided by the PKI file:
      
          \brief Returns true if the Easy VPN client is connected, false otherwise.
          
          \return bool, true if the Easy VPN client is connected, false otherwise.
          
              
      Specified by:
      isConnected in interface EasyVpnClient
      Returns:
      boolean Returns a boolean